From: Matthew Leeds <matthew.leeds@endlessm.com>
Date: Fri, 28 Sep 2018 01:30:10 +0000 (-0700)
Subject: man/ostree.repo-config: Document locking options
X-Git-Tag: archive/raspbian/2022.1-3+rpi1~1^2~4^2~19^2~27
X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:///%22http:/www.example.com/cgi/%22https:/www.github.com/%22bookmarks:/?a=commitdiff_plain;h=1a7536c0f92063ccb36b43850c6ef8c75c9f84df;p=ostree.git

man/ostree.repo-config: Document locking options

This commit documents the "locking" and "lock-timeout-secs" options
which have been around for a few releases.

Closes: #1737
Approved by: jlebon
---

diff --git a/man/ostree.repo-config.xml b/man/ostree.repo-config.xml
index dc126d65..8942a00b 100644
--- a/man/ostree.repo-config.xml
+++ b/man/ostree.repo-config.xml
@@ -198,6 +198,23 @@ Boston, MA 02111-1307, USA.
         </para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><varname>locking</varname></term>
+        <listitem><para>Boolean value controlling whether or not OSTree does
+        repository locking internally. This uses file locks and is
+        hence for multiple process exclusion (e.g. Flatpak and OSTree
+        writing to the same repository separately). This is enabled by
+        default since 2018.5.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>lock-timeout-secs</varname></term>
+        <listitem><para>Integer value controlling the number of seconds to
+        block while attempting to acquire a lock (see above). A value
+        of -1 means block indefinitely. The default value is 30.
+        </para></listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>